#ifndef DOXYGEN_H_
# define DOXYGEN_H_

/**
** @mainpage Rush video-game : Tower Defense
**
** @date From 25 / 10 / 2012 Project presentation
** @date To 27 / 10 / 2012 Project submission
**
** @section Presentation
**
**  ######   ####### #######   #######   #####   ####  #######
** ########  ####### ########  ########  ###### #####  #######
** ##    ##  ###     ###   ##  ###   ##  ###  ###  ##  ###
** ########  ####### ########  ###   ##  ###   #   ##  #######
** ##  ##    ###     ###   ##  ###   ##  ###       ##  ###
** ##   ##   ###     ###   ##  ###   ##  ###       ##  ###
** ##    ##  ####### ###   ##  #######   ###       ##  #######
**
**     Project     : rush-jeu
**     Start       : 25 / 10 / 2012
**     End         : 27 / 10 / 2012
**     Authors     : sellem_t
**                   dumont_h
**                   aurier_j
**
** To compile the project, execute :
**
**     - make
**
** Here are all the different commands you can launch :
**
**       - make [all]     : Compile all the executables.
**
**       - make *exe*     : Compile a specific executable.
**
**       - make clean     : Delete all temporary and compilation generated files.
**
**       - make distclean : Prepare the folder to be compressed.
**                        Launches clean and also delete all binaries.
**
**       - make dist      : Create the archive rush-jeu-sellem_t
**                        containing all the project.
**
**       - make check     : If existing, launches the check.
**
**       - make doc       : Generates the documentation of the project in the doc
**                        folder
**
**
**
** Usage :
**       - To compile the whole game
**
**             make
**
**       - To compile AND launch the game :
**
**             make check
**         or
**             make && cd bin && ./tower
**
**
** @section HowTo
**
** How to play ?
**
**     - Left mouse click : Puts the currently selected tower in the right panel
**         where the mouse is. It will fail if you try to put it over some types
**         of background, on the road, or if you don't have enough money.
**
**     - Right mouse click : Changes the type of the tower you will put.
**         Right now, the type of tower doesn't change anything, but in the
**         future version, some type of towers will slow, others will AOE, etc.
**
** @section postscriptum Post-scriptum
**
** P.S. : Never underestimate the power of "Roger The Duck"
*/

#endif /* !DOXYGEN_H_ */

